/*
 * Copyright 2008 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * Copyright 2008 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.core.ext.soyc;

import java.io.Serializable;
import java.util.List;
import java.util.SortedSet;

/**
 * Represents a (possibly disjoint) region of the JavaScript output for which
 * metadata is available.
 */
public interface Story extends Serializable {
  /*
   * Corresponds to a SourceInfo.
   */

  /**
   * Describes the physical or virtual source location from which a Story
   * originated.
   */
  public interface Origin extends Serializable {
    /*
     * Corresponds to a SourceOrigin.
     */

    /**
     * Returns the line number, or <code>0</code> if there is no physical
     * location.
     */
    int getLineNumber();

    /**
     * This is usually, but not always, a URL. If it is not a URL, it will
     * typically be a Java class name.
     */
    String getLocation();
  }

  /**
   * If the Story represents a literal value, this method will return a
   * description of the type of literal. If the Story does not represent a
   * literal, this method will return <code>null</code>.
   */
  // TODO: Consider promoting the Correlation.Literal enum to a public API
  String getLiteralTypeName();

  /**
   * Gets the Members of the compilation that the Story is about.
   */
  SortedSet<Member> getMembers();

  /**
   * Gets a list of transformations applied to the original source code in order
   * to produce the story entry. This method will not return any data unless the
   * compiler has been configured to collect mutation data.
   */
  List<String> getMutations();

  /**
   * Returns the locations of the Story's source. Identical structures (such as
   * string literals) that appear in multiple locations in the source may be
   * merged by the compiler into a single Story.
   */
  SortedSet<Origin> getSourceOrigin();

}